<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the HEAD class from the http library, for the Dart programming language.">
  <title>HEAD class - http library - Dart API</title>

  
  <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet">
  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
  <link rel="stylesheet" href="../static-assets/github.css">
  <link rel="stylesheet" href="../static-assets/styles.css">
  <link rel="icon" href="../static-assets/favicon.png">
  <!-- header placeholder -->
</head>

<body>

<div id="overlay-under-drawer"></div>

<header id="title">
  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">retrofit</a></li>
    <li><a href="../http/http-library.html">http</a></li>
    <li class="self-crumb">HEAD class</li>
  </ol>
  <div class="self-name">HEAD</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<main>

  <div id="dartdoc-sidebar-left" class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
      <form class="search-sidebar" role="search">
        <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
      </form>
    </header>
    
    <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
      <li><a href="../index.html">retrofit</a></li>
      <li><a href="../http/http-library.html">http</a></li>
      <li class="self-crumb">HEAD class</li>
    </ol>
    
    <h5>http library</h5>
    <ol>
      <li class="section-title"><a href="../http/http-library.html#classes">Classes</a></li>
      <li><a href="../http/Body-class.html">Body</a></li>
      <li><a href="../http/DELETE-class.html">DELETE</a></li>
      <li><a href="../http/Field-class.html">Field</a></li>
      <li><a href="../http/FormUrlEncoded-class.html">FormUrlEncoded</a></li>
      <li><a href="../http/GET-class.html">GET</a></li>
      <li><a href="../http/HEAD-class.html">HEAD</a></li>
      <li><a href="../http/Header-class.html">Header</a></li>
      <li><a href="../http/Headers-class.html">Headers</a></li>
      <li><a href="../http/HttpMethod-class.html">HttpMethod</a></li>
      <li><a href="../http/Method-class.html">Method</a></li>
      <li><a href="../http/MultiPart-class.html">MultiPart</a></li>
      <li><a href="../http/OPTIONS-class.html">OPTIONS</a></li>
      <li><a href="../http/Part-class.html">Part</a></li>
      <li><a href="../http/PATCH-class.html">PATCH</a></li>
      <li><a href="../http/Path-class.html">Path</a></li>
      <li><a href="../http/POST-class.html">POST</a></li>
      <li><a href="../http/PUT-class.html">PUT</a></li>
      <li><a href="../http/Queries-class.html">Queries</a></li>
      <li><a href="../http/Query-class.html">Query</a></li>
      <li><a href="../http/RestApi-class.html">RestApi</a></li>
    
    
    
    
    
    
    
    
    </ol>
  </div>

  <div id="dartdoc-main-content" class="col-xs-12 col-sm-9 col-md-8 main-content">
      <div><h1><span class="kind-class">HEAD</span> class </h1></div>

    <section class="desc markdown">
      <p>Make a <code>HEAD</code> request</p>
    </section>
    
    <section>
      <dl class="dl-horizontal">
        <dt>Inheritance</dt>
        <dd><ul class="gt-separated dark clazz-relationships">
          <li>Object</li>
          <li><a href="../http/Method-class.html">Method</a></li>
          <li>HEAD</li>
        </ul></dd>





        <dt>Annotations</dt>
        <dd><ul class="annotation-list clazz-relationships">
          <li>@immutable</li>
        </ul></dd>
      </dl>
    </section>

    <section class="summary offset-anchor" id="constructors">
      <h2>Constructors</h2>

      <dl class="constructor-summary-list">
        <dt id="HEAD" class="callable">
          <span class="name"><a href="../http/HEAD/HEAD.html">HEAD</a></span><span class="signature">(<span class="parameter" id="-param-path"><span class="type-annotation">String</span> <span class="parameter-name">path</span>, </span><wbr><span class="parameter" id="-param-autoCastResponse">{<span class="type-annotation">bool</span> <span class="parameter-name">autoCastResponse</span>: <span class="default-value">true</span>}</span><wbr>)</span>
        </dt>
        <dd>
           
          <div class="constructor-modifier features">const</div>
        </dd>
      </dl>
    </section>

    <section class="summary offset-anchor inherited" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="autoCastResponse" class="property inherited">
          <span class="name"><a href="../http/Method/autoCastResponse.html">autoCastResponse</a></span>
          <span class="signature">&#8594; bool</span>         
        </dt>
        <dd class="inherited">
          Automatically cast response to proper type for this method only <a href="../http/Method/autoCastResponse.html">[...]</a>
                  <div class="features">@experimental, final, inherited</div>
</dd>
        <dt id="hashCode" class="property inherited">
          <span class="name"><a href="../http/HEAD/hashCode.html">hashCode</a></span>
          <span class="signature">&#8594; int</span>         
        </dt>
        <dd class="inherited">
          The hash code for this object. <a href="../http/HEAD/hashCode.html">[...]</a>
                  <div class="features">read-only, inherited</div>
</dd>
        <dt id="method" class="property inherited">
          <span class="name"><a href="../http/Method/method.html">method</a></span>
          <span class="signature">&#8594; String</span>         
        </dt>
        <dd class="inherited">
          HTTP request method which can be found in <a href="../http/HttpMethod-class.html">HttpMethod</a>. 
                  <div class="features">final, inherited</div>
</dd>
        <dt id="path" class="property inherited">
          <span class="name"><a href="../http/Method/path.html">path</a></span>
          <span class="signature">&#8594; String</span>         
        </dt>
        <dd class="inherited">
          A relative or absolute path, or full URL of the endpoint. <a href="../http/Method/path.html">[...]</a>
                  <div class="features">final, inherited</div>
</dd>
        <dt id="runtimeType" class="property inherited">
          <span class="name"><a href="../http/HEAD/runtimeType.html">runtimeType</a></span>
          <span class="signature">&#8594; Type</span>         
        </dt>
        <dd class="inherited">
          A representation of the runtime type of the object. 
                  <div class="features">read-only, inherited</div>
</dd>
      </dl>
    </section>

    <section class="summary offset-anchor inherited" id="instance-methods">
      <h2>Methods</h2>
      <dl class="callables">
        <dt id="noSuchMethod" class="callable inherited">
          <span class="name"><a href="../http/HEAD/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation">Invocation</span> <span class="parameter-name">invocation</span></span><wbr>)
            <span class="returntype parameter">&#8594; dynamic</span>
          </span>
                  </dt>
        <dd class="inherited">
          Invoked when a non-existent method or property is accessed. <a href="../http/HEAD/noSuchMethod.html">[...]</a>
                  <div class="features">inherited</div>
</dd>
        <dt id="toString" class="callable inherited">
          <span class="name"><a href="../http/HEAD/toString.html">toString</a></span><span class="signature">(<wbr>)
            <span class="returntype parameter">&#8594; String</span>
          </span>
                  </dt>
        <dd class="inherited">
          Returns a string representation of this object. 
                  <div class="features">inherited</div>
</dd>
      </dl>
    </section>

    <section class="summary offset-anchor inherited" id="operators">
      <h2>Operators</h2>
      <dl class="callables">
        <dt id="operator ==" class="callable inherited">
          <span class="name"><a href="../http/HEAD/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">dynamic</span> <span class="parameter-name">other</span></span><wbr>)
            <span class="returntype parameter">&#8594; bool</span>
          </span>
                  </dt>
        <dd class="inherited">
          The equality operator. <a href="../http/HEAD/operator_equals.html">[...]</a>
                  <div class="features">inherited</div>
</dd>
      </dl>
    </section>




  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-right" class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right">
    <ol>
    
      <li class="section-title"><a href="../http/HEAD-class.html#constructors">Constructors</a></li>
      <li><a href="../http/HEAD/HEAD.html">HEAD</a></li>
    
      <li class="section-title inherited">
        <a href="../http/HEAD-class.html#instance-properties">Properties</a>
      </li>
      <li class="inherited"><a href="../http/Method/autoCastResponse.html">autoCastResponse</a></li>
      <li class="inherited"><a href="../http/HEAD/hashCode.html">hashCode</a></li>
      <li class="inherited"><a href="../http/Method/method.html">method</a></li>
      <li class="inherited"><a href="../http/Method/path.html">path</a></li>
      <li class="inherited"><a href="../http/HEAD/runtimeType.html">runtimeType</a></li>
    
      <li class="section-title inherited"><a href="../http/HEAD-class.html#instance-methods">Methods</a></li>
      <li class="inherited"><a href="../http/HEAD/noSuchMethod.html">noSuchMethod</a></li>
      <li class="inherited"><a href="../http/HEAD/toString.html">toString</a></li>
    
      <li class="section-title inherited"><a href="../http/HEAD-class.html#operators">Operators</a></li>
      <li class="inherited"><a href="../http/HEAD/operator_equals.html">operator ==</a></li>
    
    
    
    
    </ol>
  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    retrofit
      1.2.0
  </span>

  <!-- footer-text placeholder -->
</footer>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="../static-assets/typeahead.bundle.min.js"></script>
<script src="../static-assets/highlight.pack.js"></script>
<script src="../static-assets/URI.js"></script>
<script id="dartdoc_script_js" src="../static-assets/script.js"></script>
<!-- footer placeholder -->

</body>

</html>
